Add or manage Custom Metadata
This guide teaches how to add or manage Custom Metadata fields as part of the Nodinite Repository Model.
Add or manage Custom Metadata
Add a new Custom Metadata field by clicking the Add Endpoint button.
Click the 'Add Custom Metadata' button to open the edit page for Custom Metadata.
You can also Edit an existing Custom Metadata field from the list in the overview.
You need to enter a unique Name to create the new Custom Metadata field.
Enter a unique name for the Custom Metadata field.
| Mandatory | Name | Description | |
|---|---|---|---|
| Name | The unique user-friendly name | ||
| Description | The optional user-friendly description | ||
| Web Site | Oprional link to external documentation or system |
Relations
The Administrator can scope a Custom Metadata field to limit what Repository entities it's available.
Also, the Administrator can determine if it should be optional or mandatory. New 6.0
Example of scoping the Custom Metadata field.
Data Type
The Data Type determines what type of content you can set. Over time, we add new Data Types.
Select one of the data types.
The following datatypes exist:
| Name | Description | |
|---|---|---|
| Text Field | Single row text field | |
| Text Area | Multi-row text field | |
| Markdown | The actual code renders as HTML in view mode | |
| Mermaid Diagram | A coded diagram that renders as an image; for examples, please visit: About mermaid | |
| Link | Hyperlink | |
| Select | Dropdown combobox with single select items | |
| Checkbox | Provides a list of checkboxes | |
| Table | Table with user-defined columns | |
| Attachment | Placeholder for any files |
Repository Types
To keep the Repository Model clean and user-friendly Custom Metadata fields can be associated with the context where they are intended to make sense. Nodinite is context-aware and will provide this information where it makes the end-users more aware, and as a result, your documentation has more meaning.
| Repository link | Description | |
|---|---|---|
| Integrations | Show Custom Metadata on Integrations | |
| Systems | Show Custom Metadata on Systems | |
| Services | Show Custom Metadata on Services | |
| Contracts | Show Custom Metadata on Contracts | |
| Message Types | Show Custom Metadata on Message Types | |
| Endpoints | Show Custom Metadata on Endpoints |
How to assign values for Custom Metadata fields
On every Nodinite Repository Model entity, where there is a Custom Metadata assigned, you can easily manage the values. For example, editing an Integration, scroll down on the page, and you will find two tabs:
- Edit
- Preview
Some of the Custom Metadata fields are directly editable; the others that are more complex have a modal with an editor with a preview section.
Click the Edit button where one exists to open the modal:
This editor is available for:
- Articles
- Markdown
- Mermaid diagrams - About mermaid